<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>webchanneltransport.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="local_closure_goog_labs_net_webchanneltransport.js.html">webchanneltransport.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2013 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Transport support for WebChannel.
<a name="line17"></a> *
<a name="line18"></a> * The &lt;code&gt;WebChannelTransport&lt;/code&gt; implementation serves as the factory
<a name="line19"></a> * for &lt;code&gt;WebChannel&lt;/code&gt;, which offers an abstraction for
<a name="line20"></a> * point-to-point socket-like communication similar to what BrowserChannel
<a name="line21"></a> * or HTML5 WebSocket offers.
<a name="line22"></a> *
<a name="line23"></a> */
<a name="line24"></a>
<a name="line25"></a>goog.provide(&#39;goog.net.WebChannelTransport&#39;);
<a name="line26"></a>
<a name="line27"></a>
<a name="line28"></a>
<a name="line29"></a>/**
<a name="line30"></a> * A WebChannelTransport instance represents a shared context of logical
<a name="line31"></a> * connectivity between a browser client and a remote origin.
<a name="line32"></a> *
<a name="line33"></a> * Over a single WebChannelTransport instance, multiple WebChannels may be
<a name="line34"></a> * created against different URLs, which may all share the same
<a name="line35"></a> * underlying connectivity (i.e. TCP connection) whenever possible.
<a name="line36"></a> *
<a name="line37"></a> * When multi-domains are supported, such as CORS, multiple origins may be
<a name="line38"></a> * supported over a single WebChannelTransport instance at the same time.
<a name="line39"></a> *
<a name="line40"></a> * Sharing between different window contexts such as tabs is not addressed
<a name="line41"></a> * by WebChannelTransport. Applications may choose HTML5 shared workers
<a name="line42"></a> * or other techniques to access the same transport instance
<a name="line43"></a> * across different window contexts.
<a name="line44"></a> *
<a name="line45"></a> * @interface
<a name="line46"></a> */
<a name="line47"></a>goog.net.WebChannelTransport = function() {};
<a name="line48"></a>
<a name="line49"></a>
<a name="line50"></a>/**
<a name="line51"></a> * The latest protocol version. The protocol version is requested
<a name="line52"></a> * from the server which is responsible for terminating the underlying
<a name="line53"></a> * wire protocols.
<a name="line54"></a> *
<a name="line55"></a> * @const
<a name="line56"></a> * @type {number}
<a name="line57"></a> * @private
<a name="line58"></a> */
<a name="line59"></a>goog.net.WebChannelTransport.LATEST_VERSION_ = 0;
<a name="line60"></a>
<a name="line61"></a>
<a name="line62"></a>/**
<a name="line63"></a> * Create a new WebChannel instance.
<a name="line64"></a> *
<a name="line65"></a> * The new WebChannel is to be opened against the server-side resource
<a name="line66"></a> * as specified by the given URL. See {@link goog.net.WebChannel} for detailed
<a name="line67"></a> * semantics.
<a name="line68"></a> *
<a name="line69"></a> * @param {string} url The URL path for the new WebChannel instance.
<a name="line70"></a> * @param {!goog.net.WebChannel.Options=} opt_options Configuration for the
<a name="line71"></a> *     new WebChannel instance. The configuration object is reusable after
<a name="line72"></a> *     the new channel instance is created.
<a name="line73"></a> * @return {!goog.net.WebChannel} the newly created WebChannel instance.
<a name="line74"></a> */
<a name="line75"></a>goog.net.WebChannelTransport.prototype.createWebChannel = goog.abstractMethod;
</pre>


</body>
</html>
